Get Number Removal Status Summary
The Get Number Removal Status Summary request retrieves a summary of the removal status of all Operator Connect telephone numbers for monitoring and reporting purposes.
| ■ | Request Handling Rules: |
| ● | MarkedForRemoval status (value 2): Numbers identified as missing from OC acquired numbers list |
| ● | ReadyForRemoval status (value 3): Numbers confirmed to be deleted and ready for final removal |
| ● | TotalCounts represents the sum of MarkedForRemoval and ReadyForRemoval counts |
| ● | When msTenantId is omitted, aggregates data across all tenants |
| ■ | Validation Rules: |
| ● | msTenantId must be a valid GUID format when provided |
| ● | Empty or null msTenantId is acceptable and returns global summary |
URI
{{baseUrl}}/api/v3/oc/numbers/removal-status/summaryHTTP Method
GET
Request Parameters
|
Parameter |
Type |
Description |
|---|---|---|
|
msTenantId |
string |
Customer's Microsoft Azure Tenant Subscription Id (GUID format) to filter numbers. This parameter is optional; if not provided, returns summary for all tenants. |
Example Response
{
"markedForRemovalCount": 0,
"readyForRemovalCount": 0,
"totalCount": 0
}HTTP Responses
| ■ | 200 OK |
|
Parameter |
Type |
Description |
|---|---|---|
| markedForRemovalCount | Integer |
The count for numbers that have been marked for removal |
|
readyForRemovalCount |
Integer |
The count for numbers that are ready for removal. |
|
totalCounts |
Integer |
The total numbers count including those marked for removal and those ready for removal. |
| ■ | 400 Bad Request |
The table below shows the full list of fields returned in this response. The actual fields returned may differ according to the request.
|
Parameter |
Type |
Description |
|||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
type |
string |
Error type |
|||||||||
|
title |
string |
Email title |
|||||||||
|
status |
integer |
The status of the connection with M365 platform:
|
|||||||||
|
detail |
string |
Additional error details. |
|||||||||
|
instance |
string |
Error instance. |
|||||||||
|
errorTicket |
string |
The error ticket string opened for this request. |
|||||||||
|
errorCode |
string |
Error code output in the request |
|||||||||
|
traceId |
string |
The trace id of the request |
|||||||||
|
additionalProp1 |
string |
Custom Script variable argument. For example IP-Network. |
|||||||||
|
additionalProp2 |
string |
Custom Script argument. For example, IP-SubnetBits. |
|||||||||
|
additionalProp3 |
string |
Custom Script argument. For example, Trusted-IP-Network. |
| ■ | 500 Internal Server Error |